home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / os20 / wb / toolmanager2_0.lha / ToolManager / Docs / toolmanager.doc < prev   
Text File  |  1992-09-26  |  9KB  |  263 lines
  1. TABLE OF CONTENTS
  2.  
  3. toolmanager.library/AllocTMHandle
  4. toolmanager.library/ChangeTMObjectTagList
  5. toolmanager.library/CreateTMObjectTagList
  6. toolmanager.library/DeleteTMObject
  7. toolmanager.library/FreeTMHandle
  8. toolmanager.library/QuitToolManager
  9.  
  10. toolmanager.library/AllocTMHandle            toolmanager.library/AllocTMHandle
  11.  
  12.    NAME
  13.         AllocTMHandle -- Allocate a ToolManager handle
  14.  
  15.    SYNOPSIS
  16.         handle = AllocTMHandle()
  17.         D0
  18.  
  19.         void *AllocTMHandle(void)
  20.  
  21.    FUNCTION
  22.         Allocates a ToolManager handle, a private data structure. All
  23.         ToolManager objects will be attached to a handle. The library
  24.         function use the handle to access the objects.
  25.  
  26.    RESULTS
  27.         handle - pointer to the new allocated handle or NULL.
  28.  
  29.    SEE ALSO
  30.         FreeTMHandle()
  31.  
  32. toolmanager.library/ChangeTMObjectTagList toolmanager.library/ChangeTMObjectTagList
  33. toolmanager.library/ChangeTMObjectTags   toolmanager.library/ChangeTMObjectTags
  34.  
  35.    NAME
  36.         ChangeTMObjectTagList -- Change the properties of a ToolManager object
  37.  
  38.    SYNOPSIS
  39.         success = ChangeTMObjectTagList(handle, object, tags)
  40.         D0                              A0      A1      A2
  41.  
  42.         BOOL ChangeTMObjectTagList(void *, char *, struct TagItem *)
  43.  
  44.         success = ChangeTMObjectTags(handle, object, tag1, ...)
  45.  
  46.         BOOL ChangeTMObjectTags(void *, char *, ULONG, ...)
  47.  
  48.    FUNCTION
  49.         Changes the properties of a ToolManager object according to the
  50.         supplied tags. All derived objects will be automagically updated to
  51.         reflect the new properties.
  52.  
  53.    INPUTS
  54.         handle - pointer to a ToolManager handle.
  55.         object - pointer to name of the ToolManager object to change. The
  56.                  object must be attached to the handle.
  57.         tags - list of TagItems, which describe the properties to be changed.
  58.                See CreateTMObjectTagList() for a list of all available tags.
  59.  
  60.    RESULTS
  61.         success - TRUE if properties were changed, otherwise FALSE.
  62.  
  63.    NOTE
  64.         Currently objects of type TMOBJTYPE_IMAGE can't be changed.
  65.  
  66.    SEE ALSO
  67.         CreateTMObjectTagList()
  68.  
  69. toolmanager.library/CreateTMObjectTagList toolmanager.library/CreateTMObjectTagList
  70. toolmanager.library/CreateTMObjTags         toolmanager.library/CreateTMObjTags
  71.  
  72.    NAME
  73.         CreateTMObjectTagList -- Create a ToolManager object
  74.  
  75.    SYNOPSIS
  76.         success = CreateTMObjectTagList(handle, name, type, tags)
  77.         D0                              A0      A1    D0    A2
  78.  
  79.         BOOL CreateTMObjectTagList(void *, char *, ULONG, struct TagItem *)
  80.  
  81.         success = CreateTMObjectTags(handle, name, type, Tag1, ...)
  82.  
  83.         BOOL CreateTMObjectTags(void *, char *, ULONG, ULONG, ...)
  84.  
  85.    FUNCTION
  86.         Creates a new ToolManager object of the given type. The properties
  87.         will be set according to the supplied tags. The new object will be
  88.         attached to the ToolManager handle.
  89.  
  90.         The following tags are currently supported, see Object.doc for
  91.         detailed description.
  92.  
  93.         NOTE: Every data item referenced by a pointer will NOT BE COPIED! It
  94.               must therefore exist for the lifetime of the object!
  95.  
  96.          Object type: TMOBJTYPE_EXEC
  97.  
  98.            - TMOP_Arguments  (BOOL)
  99.            - TMOP_Command    type depending on TMOP_ExecType
  100.            - TMOP_CurrentDir (char *)
  101.            - TMOP_Delay      (LONG)
  102.            - TMOP_ExecType   (ULONG)
  103.  
  104.               One of:
  105.  
  106.                - TMET_CLI    TMOP_Command contains a pointer to string
  107.                - TMET_WB                      "
  108.                - TMET_ARexx                   "
  109.                - TMET_Hook   TMOP_Command contains a pointer to a Hook
  110.                              structure (see utility/hooks.h). When the exec
  111.                              object is activated, ToolManager will call
  112.                              h_Entry with a pointer to the Hook structure in
  113.                              A0 (hook), a pointer to an AppMessage in A1
  114.                              (message, this may be NULL) and the value of
  115.                              h_Data in A2 (object). The function must return
  116.                              a BOOL (TRUE for success, FALSE for failure).
  117.  
  118.                              NOTE: The function will be called synchronously
  119.                              and in the task context of the ToolManager
  120.                              handler. So it MUST return AS SOON AS POSSIBLE and
  121.                              MUST NOT MODIFY ANYTHING in the task context!!!!!
  122.  
  123.            - TMOP_HotKey     (char *)
  124.            - TMOP_Output     (char *)
  125.            - TMOP_Path       (char *)
  126.            - TMOP_Priority   (LONG)
  127.            - TMOP_PubScreen  (char *)
  128.            - TMOP_Stack      (ULONG)
  129.            - TMOP_ToFront    (BOOL)
  130.  
  131.          Object type: TMOBJTYPE_IMAGE
  132.  
  133.            - TMOP_File       (char *)
  134.            - TMOP_Data       (struct TMImageData *)
  135.                                        Pointer to a list of images. All images
  136.                                        MUST be if the same size. Will be
  137.                                        ignored if TMOP_File is specified.
  138.                                        Look into <libraries/toolmanager.h> for
  139.                                        detailed description of the data
  140.                                        structure
  141.  
  142.          Object type: TMOBJTYPE_SOUND
  143.  
  144.            - TMOP_Command    (char *)  ARexx command string for external sound
  145.                                        player
  146.            - TMOP_Port       (char *)  Port name of external sound player
  147.  
  148.          Object type: TMOBJTYPE_MENU
  149.  
  150.            - TMOP_Exec       (char *)
  151.            - TMOP_Sound      (char *)
  152.  
  153.          Object type: TMOBJTYPE_ICON
  154.  
  155.            - TMOP_Exec       (char *)
  156.            - TMOP_Image      (char *)
  157.            - TMOP_LeftEdge   (LONG)
  158.            - TMOP_ShowName   (BOOL)
  159.            - TMOP_Sound      (char *)
  160.            - TMOP_TopEdge    (LONG)
  161.  
  162.          Object type: TMOBJTYPE_DOCK
  163.  
  164.            - TMOP_Activated  (BOOL)
  165.            - TMOP_Centered   (BOOL)
  166.            - TMOP_Columns    (ULONG)
  167.            - TMOP_Font       (struct TextAttr *)
  168.            - TMOP_FrontMost  (BOOL)
  169.            - TMOP_HotKey     (char *)
  170.            - TMOP_LeftEdge   (LONG)
  171.            - TMOP_Menu       (BOOL)
  172.            - TMOP_Pattern    (BOOL)
  173.            - TMOP_PopUp      (BOOL)
  174.            - TMOP_PubScreen  (char *)
  175.            - TMOP_Text       (BOOL)
  176.            - TMOP_Title      (char *)
  177.            - TMOP_Tools      (char **) can be specified several times.
  178.            - TMOP_TopEdge    (LONG)
  179.            - TMOP_Vertical   (BOOL)
  180.  
  181.    INPUTS
  182.         handle - pointer to a ToolManager handle
  183.         name - pointer to a string which contains the name of the new object.
  184.         type - type of the new object. Must be one of the following:
  185.  
  186.                 TMOBJTYPE_EXEC   (see Object.doc for an detailed explanation
  187.                 TMOBJTYPE_IMAGE   of the object types)
  188.                 TMOBJTYPE_SOUND
  189.                 TMOBJTYPE_MENU
  190.                 TMOBJTYPE_ICON
  191.                 TMOBJTYPE_DOCK
  192.  
  193.         tags - list of TagItems, which describe the properties of the new
  194.                object.
  195.  
  196.    RESULTS
  197.         success - TRUE if object could be created, otherwise FALSE.
  198.  
  199.    SEE ALSO
  200.         DeleteTMObject()
  201.  
  202. toolmanager.library/DeleteTMObject          toolmanager.library/DeleteTMObject
  203.  
  204.    NAME
  205.         DeleteTMObject -- Delete a ToolManager object
  206.  
  207.    SYNOPSIS
  208.         success = DeleteTMObject(handle, object)
  209.         D0                       A0      A1
  210.  
  211.         BOOL DeleteTMObject(void *, char *)
  212.  
  213.    FUNCTION
  214.         Deletes a ToolManager object created with CreateTMObjectTagList().
  215.         All derived objects will be automagically updated.
  216.  
  217.    INPUTS
  218.         handle - pointer to a ToolManager handle.
  219.         object - pointer to the name of the ToolManager object to delete.
  220.                  This object must be attached to the handle.
  221.  
  222.    RESULTS
  223.         success - TRUE if object was deleted, otherwise FALSE.
  224.  
  225.    SEE ALSO
  226.         CreateTMObjectTagList()
  227.  
  228. toolmanager.library/FreeTMHandle              toolmanager.library/FreeTMHandle
  229.  
  230.    NAME
  231.         FreeTMHandle -- Free a ToolManager handle
  232.  
  233.    SYNOPSIS
  234.         FreeTMHandle(handle)
  235.                      A0
  236.  
  237.         void FreeTMHandle(void *)
  238.  
  239.    FUNCTION
  240.         Frees a ToolManager handle and deletes all attached objects.
  241.  
  242.    INPUT
  243.         handle - pointer to the ToolManager handle.
  244.  
  245.    SEE ALSO
  246.         AllocTMHandle()
  247.  
  248. toolmanager.library/QuitToolManager        toolmanager.library/QuitToolManager
  249.  
  250.    NAME
  251.         QuitToolManager -- Send quit signal to ToolManager process
  252.  
  253.    SYNOPSIS
  254.         QuitToolManager()
  255.  
  256.         void QuitToolManager(void)
  257.  
  258.    FUNCTION
  259.         Sends quit signal to the ToolManager handler process. The process
  260.         will try to exit as soon as possible.
  261.  
  262.  
  263.